home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / efun / set_heart_beat < prev    next >
Text File  |  2001-06-04  |  663b  |  20 lines
  1. SYNOPSIS
  2.         int set_heart_beat(int flag)
  3.  
  4. DESCRIPTION
  5.         Enable or disable heart beat. The driver will apply
  6.         the lfun heart_beat() to the current object every 2 seconds,
  7.         if it is enabled. If the heart beat is not needed for the
  8.         moment, then do disable it. This will reduce system overhead.
  9.         
  10.         Return true for success, and false for failure.
  11.  
  12.         Disabling an already disabled heart beat (and vice versa
  13.         enabling and enabled heart beat) counts as failure.
  14.  
  15.         Note that heart_beat()s are called only if there are interactive
  16.         players in the game.
  17.  
  18. SEE ALSO
  19.         heart_beat(A), call_out(E)
  20.